[beta] Update a Function.

Update an existing Function’s description and configuration. The request must include lastUpdateTimestampMs, which is the timestamp value obtained from a previous create or get response. The response includes a URL (uploadPutUrl) for uploading new code. After uploading, call POST /functions/{name}/deploy for the changes to be applied.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Functions under the Functions category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

PATCH /functions/{name}

[beta] Update a Function.

cURL

curl --request PATCH \
  --url https://api.samsara.com/functions/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastUpdateTimestampMs": 1609459200000,
  "config": {
    "handler": "index.handler",
    "isScheduleEnabled": false,
    "params": {
      "region": "us-west",
      "threshold": "100"
    },
    "secrets": {
      "API_KEY": "my-secret-value"
    }
  },
  "description": "Processes incoming telemetry data."
}
'

200

{
  "data": {
    "lastUpdateTimestampMs": 1609459200000,
    "name": "my-function",
    "updatedAtTime": "2021-01-01T00:00:00Z",
    "uploadPutUrl": "https://example.com/upload?token=..."
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name · string · required

The name of the Function to update.

Body

application/json

Request body for updating a Function.

lastUpdateTimestampMs · integer<int64> · required

Timestamp of the last known update to this Function, obtained from a create or get response. Required to prevent conflicting updates.

Example:

1609459200000

config · object

Configuration fields to update on the Function. All fields are optional; only provided fields are updated.

Show child attributes

description · string

A description of the Function.

Example:

"Processes incoming telemetry data."

Response

200

application/json

OK response.

data · object · required

Details of an updated Function, including a URL for uploading a new code package. After uploading, call the deploy endpoint for the changes to be applied.

Show child attributes